﻿#region Copyright (c) 2003 - 2008, Andreas Mueller
/////////////////////////////////////////////////////////////////////////////////////////
// 
// Copyright (c) 2003 - 2008, Andreas Mueller.
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// Contributors:
//    Andreas Mueller - initial API and implementation
//
// 
// This software is derived from software bearing the following
// restrictions:
// 
// Copyright (c) 1994
// Hewlett-Packard Company
// 
// Permission to use, copy, modify, distribute and sell this software
// and its documentation for any purpose is hereby granted without fee,
// provided that the above copyright notice appear in all copies and
// that both that copyright notice and this permission notice appear
// in supporting documentation.  Hewlett-Packard Company makes no
// representations about the suitability of this software for any
// purpose.  It is provided "as is" without express or implied warranty.
// 
// 
// Copyright (c) 1996,1997
// Silicon Graphics Computer Systems, Inc.
// 
// Permission to use, copy, modify, distribute and sell this software
// and its documentation for any purpose is hereby granted without fee,
// provided that the above copyright notice appear in all copies and
// that both that copyright notice and this permission notice appear
// in supporting documentation.  Silicon Graphics makes no
// representations about the suitability of this software for any
// purpose.  It is provided "as is" without express or implied warranty.
// 
// 
// (C) Copyright Nicolai M. Josuttis 1999.
// Permission to copy, use, modify, sell and distribute this software
// is granted provided this copyright notice appears in all copies.
// This software is provided "as is" without express or implied
// warranty, and with no claim as to its suitability for any purpose.
// 
/////////////////////////////////////////////////////////////////////////////////////////
#endregion



using System.Collections.Generic;
using NStl.Linq;
using NUnit.Framework;



namespace NStl.NUnit.Support
{
    /// <summary>
    /// Base class for to test a <see cref="ICollection{T}"/> implementation.
    /// </summary>
    /// <typeparam name="T"></typeparam>
    public abstract class CollectionTFixture<T> : EnumerableTFixture<T>
    {
        protected sealed override IEnumerable<T> CreateEnumerableT()
        {
            return CreateCollectionT();
        }
        protected ICollection<T> CollectionT
        {
            get { return (ICollection<T>)EnumerableT; }
        }
        /// <summary>
        /// When implemented it returns a filled instance of the
        /// collection under test.
        /// </summary>
        /// <returns></returns>
        protected abstract ICollection<T> CreateCollectionT();
        

        [SetUp]
        public override void Setup()
        {
            base.Setup();
         }
        protected abstract T CreateNewUniqueItem();
        [Test]
        public void Add()
        {
            T toAdd = CreateNewUniqueItem();

            CollectionAssert.DoesNotContain(CollectionT, toAdd);
            CollectionT.Add(toAdd);

            CollectionAssert.Contains(CollectionT, toAdd);
        }

        [Test]
        public void Clear()
        {
            CollectionAssert.IsNotEmpty(CollectionT);
            CollectionT.Clear();
            CollectionAssert.IsEmpty(CollectionT);
        }
        [Test]
        public void Contains()
        {
            T toAdd = CreateNewUniqueItem();

            CollectionAssert.DoesNotContain(CollectionT, toAdd);
            Assert.IsFalse(CollectionT.Contains(toAdd));
            
            CollectionT.Add(toAdd);

            Assert.IsTrue(CollectionT.Contains(toAdd));
        }

        [Test]
        public void CopyTo()
        {
            T[] target = new T[CollectionT.Count];
            CollectionT.CopyTo(target, 0);

            CollectionAssert.AreEqual(CollectionT.AsCollection(), target);
        }

        [Test]
        public void CopyToWithOffset()
        {
            CopyToWithOffset(5);
        }
        [Test]
        public void CopyToWithOffset0()
        {
            CopyToWithOffset(0);
        }
        public void CopyToWithOffset(int offset)
        {
            T[] target = new T[CollectionT.Count + offset];

            CollectionT.CopyTo(target, offset);
            CollectionAssert.IsSubsetOf(CollectionT, target);
            Assert.AreEqual(target[target.Length - 1], LastOfCollection());
        }
        private T LastOfCollection()
        {
            IEnumerator<T> e = CollectionT.GetEnumerator();
            T current = default(T);
            while (e.MoveNext())
                current = e.Current;

            return current;
        }

        [Test]
        public void Remove()
        {
            T toAdd = CreateNewUniqueItem();

            CollectionAssert.DoesNotContain(CollectionT, toAdd);
            CollectionT.Add(toAdd);

            CollectionAssert.Contains(CollectionT, toAdd);

            Assert.IsTrue(CollectionT.Remove(toAdd));
            CollectionAssert.DoesNotContain(CollectionT, toAdd);
        }
        [Test]
        public void RemoveItemThatIsNotInCollection()
        {
            T notInCollection = CreateNewUniqueItem();
            Assert.IsFalse(CollectionT.Remove(notInCollection));
        }

        [Test]
        public void Count()
        {
            int startCount = CollectionT.Count;

            T toAdd = CreateNewUniqueItem();
            CollectionAssert.DoesNotContain(CollectionT, toAdd);
            CollectionT.Add(toAdd);

            Assert.AreEqual(startCount + 1, CollectionT.Count);

            CollectionT.Remove(toAdd);
            Assert.AreEqual(startCount, CollectionT.Count);
        }
        [Test]
        public void IsReadOnly()
        {
            Assert.IsFalse(CollectionT.IsReadOnly);
        }
    }
}
